Conversation
|
/cc @FranzBusch - leaving this in draft state at the moment, can easily adjust to whatever the ESG prefers to use here. |
heckj
changed the title
heckj
force-pushed
the
practice-template
branch
from
03c763e to
690c644
Compare
|
@FranzBusch I added a "how to create an article" to match the template, and added a placeholder that would easily house future best practices. I didn't put in anything about how the articles are reviewed or vetted, but happy to help write up something with the ESG if the group has a process they'd like to have documented. |
ecosystem-tools/Sources/EcosystemTools.docc/best-practices/best-practice-content.md
Outdated
Show resolved
Hide resolved
ecosystem-tools/Sources/EcosystemTools.docc/best-practices/best-practice-content.md
Outdated
Show resolved
Hide resolved
|
|
||
| Create clear guidance with examples for best practice documentation. | ||
|
|
||
| ## Overview |
There was a problem hiding this comment.
We need a section here that says that initially this is intended for the ESG to provide best practices
…the template provided. Adds structure to host best practices in the future
Co-authored-by: Franz Busch <privat@franz-busch.de>
… sspelling fixes across the two files
| @Metadata { | ||
| @DisplayName("Tools and Editors") | ||
| } No newline at end of file | ||
| @DisplayName("Ecosystem") |
There was a problem hiding this comment.
Question for the ESG more generally -
I was planning on migrating in content from the Swift.org website that relate to the articles about setting up various editors and systems to work with Swift: NVim/NeoVim, Emacs, VSCode - which is what inspired the original "display name". That doesn't quite bit if we're also offering more general best practices going forward, so it needs something else - but I'm at a loss at the moment on anything to suggest.
To illustrate where this fits in and what it effects, it's the displayed "name" of this catalog that will be alongside others in a combined "DocC Archive" for Swift docs - with the current setup of that:
Note: this isn't how it's published now, but how we're aiming to publish it - as a combined DocC archive that's hosted under a version tag for versioned output (such as a URL akin to
docs.swift.org/6.3/documentation)
2 participants
Summary
Provides a template for the Ecosystems Steering Group to utilize for providing guidance when using Swift.
Type of Change
Documentation Package(s) Affected
Changes Made
DocC Markdown template file for a best practice guide/article.
Technical Review Required
Additional Notes
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.